Get SIP Connections
This request retrieves a specific customer SIP Connection. Once you have setup the primary site location, you can add additional branch sites and then provision SBC prefixes for the users at these locations.
URL
{{baseUrl}}/api/v2/sitelocation/{SiteLocationId}HTTP Method
GET
Request Parameter
|
Parameter |
Type |
Description |
|---|---|---|
|
Id |
string($uuid) |
This value is identical to 'umpCustomerGuid' if a single site exists and is unique if additional sites are defined. Extract this value using Get Specific Customer Details request by searching in the response for the matching site name. |
Example Response
{
"tenantId": "3371606b-f589-4b50-b827-1a95cacf7225",
"m365DeploymentState": null,
"sbcDeploymentState": 3,
"siteName": "DR94Site2",
"onlinePstnGateway": "DR94Site2.sandbox2.audiocodes.be",
"sbcInfo": {
"sbcConfigurationType": 0,
"cacProfile": "10 sessions",
"carrierHostName": "Site2Hostname123",
"carrierId": "SIPTrunk",
"carrierMainLine": null,
"carrierUserName": "Site2Carrier",
"flagConfigureSbc": true,
"sbcId": 8,
"sbcScripts": {
"onboardingScript": 7,
"cleanupScript": 700,
"customerVariables": {
"CarrierUserPassword": "Site2#%00500",
"CarierMailLine": "Site2MainLine123",
"CustomVar.Variable1": "variable4"
}
}
},
"m365Info": {
"m365Scripts": {
"flagConfigureM365Routing": false,
"onboardingScript": null,
"cleanupScript": null,
"customerVariables": null
}
},
"pendingTasks": []
}HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
tenantId |
string |
Microsoft tenant subscription Id |
||||||||||||||||||||||||||||||||||||
|
m365DeploymentState |
integer |
One of the following values:
|
||||||||||||||||||||||||||||||||||||
|
sbcDeploymentState |
integer |
One of the following values:
|
||||||||||||||||||||||||||||||||||||
|
siteName |
string |
Site location name. |
||||||||||||||||||||||||||||||||||||
|
onlinePstnGateway |
string |
FQDN of the Online PSTN gateway. See Get Online PSTN Gateway for a list of PSTN gateways configured in the deployment. |
||||||||||||||||||||||||||||||||||||
|
sbcInfo |
list array |
List array including the following parameters:
|
||||||||||||||||||||||||||||||||||||
|
sbcConfigurationType |
integer |
One of the following values: 1- SIP Trunk; 2- IP-PBX; 3-BYOC (Bring-Your-Own-Carrier) |
||||||||||||||||||||||||||||||||||||
|
Cac Profile |
string |
Defines the desired number of Call Admission Control (CAC) call sessions. For example, "10 sessions". This value also represents the name of the CAC profile. |
||||||||||||||||||||||||||||||||||||
|
carrierHostName |
string |
Defines the Address of Record (AOR) host name. The host name appears in SIP REGISTER From/To headers as ContactUser@HostName. |
||||||||||||||||||||||||||||||||||||
|
carrierId |
string |
Carrier name e.g. SIP Trunk |
||||||||||||||||||||||||||||||||||||
|
carrierMainLine |
string |
MainLine (Contact User): Defines the AOR username. This appears in REGISTER From/To headers as ContactUser@HostName |
||||||||||||||||||||||||||||||||||||
|
carrierUserName |
string |
Defines the digest MD5 Authentication username. The valid value is a string of up to 60 characters. By default, no value is defined. |
||||||||||||||||||||||||||||||||||||
|
flagConfigureSbc |
boolean |
Indicates whether the SBC device is configured in the Onboarding. This parameter must be enabled for applying the SBC-related parameters in this request. |
||||||||||||||||||||||||||||||||||||
|
sbcId |
integer |
Id of the SBC in the Live Cloud database. |
||||||||||||||||||||||||||||||||||||
|
sbcScripts |
list array |
List array including the following parameters:
|
||||||||||||||||||||||||||||||||||||
|
onboardingScript |
integer |
Database value of the SBC Onboarding script. |
||||||||||||||||||||||||||||||||||||
|
cleanupScript |
integer |
Database value of the SBC Cleanup script. |
||||||||||||||||||||||||||||||||||||
|
customerVariables |
integer |
Database value of the SBC customer-defined variables. |
||||||||||||||||||||||||||||||||||||
|
m365Info |
list array |
List array including the m365Scripts list. |
||||||||||||||||||||||||||||||||||||
|
m365Scripts |
list array |
List array including the following parameters:
|
||||||||||||||||||||||||||||||||||||
|
onboardingScript |
integer |
Live Platform database value of the M365 Onboarding script. |
||||||||||||||||||||||||||||||||||||
|
cleanupScript |
integer |
Live Platform database value of the M365 Cleanup script. |
||||||||||||||||||||||||||||||||||||
|
customerVariables |
integer |
Live Platform database values of the M365 customer variables defined in the database. |